Skip to content

docs: add AGENTS.md with CLAUDE.md symlink#74

Merged
chenjiahan merged 2 commits into
rstackjs:mainfrom
fi3ework:docs/agents-md
May 15, 2026
Merged

docs: add AGENTS.md with CLAUDE.md symlink#74
chenjiahan merged 2 commits into
rstackjs:mainfrom
fi3ework:docs/agents-md

Conversation

@fi3ework
Copy link
Copy Markdown
Member

Summary

Add AGENTS.md documenting repository conventions for AI coding agents, with CLAUDE.md as a symlink so Claude Code picks it up too.

Covers:

  • Assets-only nature of the repo (no build / test / lint).
  • Path-equals-URL deploy model via assets.rspack.rs (renames are user-visible, subject to 4h CDN cache).
  • Naming conventions for logos, release banners (kebab-case versions like v0-10-0), OG images, navbar logos, favicons.
  • The mandatory TinyPNG compression rule from the PR template.
  • Layout: package root for stable deliverables vs. <pkg>/assets/ for ad-hoc / temporary media.

Documents repository conventions for AI coding agents: the assets-only
nature of the repo, the path-equals-URL deploy model via assets.rspack.rs,
naming conventions for logos / banners / OG images, and the mandatory
TinyPNG compression rule.

CLAUDE.md is a symlink to AGENTS.md so Claude Code picks it up too.
@fi3ework fi3ework requested a review from chenjiahan May 15, 2026 08:51
Comment thread AGENTS.md Outdated
Copy link
Copy Markdown
Member

@chenjiahan chenjiahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@chenjiahan chenjiahan merged commit 17f4084 into rstackjs:main May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants